POST Dashboard/DashboardPulse?companyId[0]={companyId[0]}&companyId[1]={companyId[1]}&startDate={startDate}&endDate={endDate}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| companyId | Collection of integer |
Required |
|
| startDate | date |
Required |
|
| endDate | date |
Required |
Body Parameters
None.
Response Information
Resource Description
IConnect.Domain.Dashboard.PulseDashboard| Name | Description | Type | Additional information |
|---|---|---|---|
| TotalNumberOfTransactions | integer |
None. |
|
| AverageSalePerTransaction | decimal number |
None. |
|
| TotalSales | decimal number |
None. |
|
| TotalProductSales | decimal number |
None. |
|
| TotalServiceSales | decimal number |
None. |
|
| TotalCost | decimal number |
None. |
|
| TotalTips | decimal number |
None. |
|
| TotalCommisions | decimal number |
None. |
|
| TotalDiscounts | decimal number |
None. |
|
| ProfitMargin | decimal number |
None. |
|
| TotalNewCustomers | integer |
None. |
|
| ScheduledHours | decimal number |
None. |
|
| LaborCost | decimal number |
None. |
|
| BookedHours | decimal number |
None. |
|
| BookedPercentage | decimal number |
None. |
|
| TotalAppointments | integer |
None. |
|
| CompletedAppointments | integer |
None. |
|
| TotalProductSalesGoal | decimal number |
None. |
|
| TotalServiceSalesGoal | decimal number |
None. |
|
| Details | Collection of IConnect.Domain.Dashboard.PulseDashboardSalesDetail |
None. |
Response Formats
application/json, text/json
Sample:
{
"TotalNumberOfTransactions": 1,
"AverageSalePerTransaction": 2.0,
"TotalSales": 3.0,
"TotalProductSales": 4.0,
"TotalServiceSales": 5.0,
"TotalCost": 6.0,
"TotalTips": 7.0,
"TotalCommisions": 8.0,
"TotalDiscounts": 9.0,
"ProfitMargin": -3.0,
"TotalNewCustomers": 10,
"ScheduledHours": 11.0,
"LaborCost": 12.0,
"BookedHours": 13.0,
"BookedPercentage": 118.18,
"TotalAppointments": 14,
"CompletedAppointments": 15,
"TotalProductSalesGoal": 16.0,
"TotalServiceSalesGoal": 17.0,
"Details": [
{
"Time": "2025-04-03T22:36:10.0204745-04:00",
"FormattedTime": "sample string 2",
"NumberOfTransactions": 3,
"AverageSalePerTransaction": 4.0,
"Discounts": 5.0,
"Tips": 6.0,
"Commisions": 7.0,
"Sales": 8.0,
"ServiceSales": 9.0,
"ProductSales": 10.0,
"CostOfGoodsSold": 16.0,
"TargetLaborCost": 17.0,
"ActualLaborCost": 18.0,
"NewCustomers": 19,
"ProductSalesGoal": 20.0,
"ServiceSalesGoal": 21.0,
"RealPayment": 22.0,
"SalesByOrderSource": [
{
"Name": "sample string 2",
"TotalSales": 3.0,
"NumberOfTransactions": 4
},
{
"Name": "sample string 2",
"TotalSales": 3.0,
"NumberOfTransactions": 4
}
],
"SalesByShippingOption": [
{
"Name": "sample string 2",
"TotalSales": 3.0,
"NumberOfTransactions": 4
},
{
"Name": "sample string 2",
"TotalSales": 3.0,
"NumberOfTransactions": 4
}
]
},
{
"Time": "2025-04-03T22:36:10.0204745-04:00",
"FormattedTime": "sample string 2",
"NumberOfTransactions": 3,
"AverageSalePerTransaction": 4.0,
"Discounts": 5.0,
"Tips": 6.0,
"Commisions": 7.0,
"Sales": 8.0,
"ServiceSales": 9.0,
"ProductSales": 10.0,
"CostOfGoodsSold": 16.0,
"TargetLaborCost": 17.0,
"ActualLaborCost": 18.0,
"NewCustomers": 19,
"ProductSalesGoal": 20.0,
"ServiceSalesGoal": 21.0,
"RealPayment": 22.0,
"SalesByOrderSource": [
{
"Name": "sample string 2",
"TotalSales": 3.0,
"NumberOfTransactions": 4
},
{
"Name": "sample string 2",
"TotalSales": 3.0,
"NumberOfTransactions": 4
}
],
"SalesByShippingOption": [
{
"Name": "sample string 2",
"TotalSales": 3.0,
"NumberOfTransactions": 4
},
{
"Name": "sample string 2",
"TotalSales": 3.0,
"NumberOfTransactions": 4
}
]
}
]
}
application/xml, text/xml
Sample:
<PulseDashboard xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Dashboard">
<AverageSalePerTransaction>2</AverageSalePerTransaction>
<BookedHours>13</BookedHours>
<CompletedAppointments>15</CompletedAppointments>
<Details>
<PulseDashboardSalesDetail>
<ActualLaborCost>18</ActualLaborCost>
<AverageSalePerTransaction>4</AverageSalePerTransaction>
<Commisions>7</Commisions>
<CostOfGoodsSold>16</CostOfGoodsSold>
<Discounts>5</Discounts>
<FormattedTime>sample string 2</FormattedTime>
<GiftCardSales>11</GiftCardSales>
<GiftCardTaxes>14</GiftCardTaxes>
<NewCustomers>19</NewCustomers>
<NumberOfTransactions>3</NumberOfTransactions>
<OrderTotal>15</OrderTotal>
<ProductSales>10</ProductSales>
<ProductSalesGoal>20</ProductSalesGoal>
<ProductTaxes>13</ProductTaxes>
<RealPayment>22</RealPayment>
<Sales>8</Sales>
<SalesByOrderSource>
<PulseDashboardSalesGroupedBy>
<Id>1</Id>
<Name>sample string 2</Name>
<NumberOfTransactions>4</NumberOfTransactions>
<TotalSales>3</TotalSales>
</PulseDashboardSalesGroupedBy>
<PulseDashboardSalesGroupedBy>
<Id>1</Id>
<Name>sample string 2</Name>
<NumberOfTransactions>4</NumberOfTransactions>
<TotalSales>3</TotalSales>
</PulseDashboardSalesGroupedBy>
</SalesByOrderSource>
<SalesByShippingOption>
<PulseDashboardSalesGroupedBy>
<Id>1</Id>
<Name>sample string 2</Name>
<NumberOfTransactions>4</NumberOfTransactions>
<TotalSales>3</TotalSales>
</PulseDashboardSalesGroupedBy>
<PulseDashboardSalesGroupedBy>
<Id>1</Id>
<Name>sample string 2</Name>
<NumberOfTransactions>4</NumberOfTransactions>
<TotalSales>3</TotalSales>
</PulseDashboardSalesGroupedBy>
</SalesByShippingOption>
<ServiceSales>9</ServiceSales>
<ServiceSalesGoal>21</ServiceSalesGoal>
<ServiceTaxes>12</ServiceTaxes>
<TargetLaborCost>17</TargetLaborCost>
<Time>2025-04-03T22:36:10.0204745-04:00</Time>
<Tips>6</Tips>
</PulseDashboardSalesDetail>
<PulseDashboardSalesDetail>
<ActualLaborCost>18</ActualLaborCost>
<AverageSalePerTransaction>4</AverageSalePerTransaction>
<Commisions>7</Commisions>
<CostOfGoodsSold>16</CostOfGoodsSold>
<Discounts>5</Discounts>
<FormattedTime>sample string 2</FormattedTime>
<GiftCardSales>11</GiftCardSales>
<GiftCardTaxes>14</GiftCardTaxes>
<NewCustomers>19</NewCustomers>
<NumberOfTransactions>3</NumberOfTransactions>
<OrderTotal>15</OrderTotal>
<ProductSales>10</ProductSales>
<ProductSalesGoal>20</ProductSalesGoal>
<ProductTaxes>13</ProductTaxes>
<RealPayment>22</RealPayment>
<Sales>8</Sales>
<SalesByOrderSource>
<PulseDashboardSalesGroupedBy>
<Id>1</Id>
<Name>sample string 2</Name>
<NumberOfTransactions>4</NumberOfTransactions>
<TotalSales>3</TotalSales>
</PulseDashboardSalesGroupedBy>
<PulseDashboardSalesGroupedBy>
<Id>1</Id>
<Name>sample string 2</Name>
<NumberOfTransactions>4</NumberOfTransactions>
<TotalSales>3</TotalSales>
</PulseDashboardSalesGroupedBy>
</SalesByOrderSource>
<SalesByShippingOption>
<PulseDashboardSalesGroupedBy>
<Id>1</Id>
<Name>sample string 2</Name>
<NumberOfTransactions>4</NumberOfTransactions>
<TotalSales>3</TotalSales>
</PulseDashboardSalesGroupedBy>
<PulseDashboardSalesGroupedBy>
<Id>1</Id>
<Name>sample string 2</Name>
<NumberOfTransactions>4</NumberOfTransactions>
<TotalSales>3</TotalSales>
</PulseDashboardSalesGroupedBy>
</SalesByShippingOption>
<ServiceSales>9</ServiceSales>
<ServiceSalesGoal>21</ServiceSalesGoal>
<ServiceTaxes>12</ServiceTaxes>
<TargetLaborCost>17</TargetLaborCost>
<Time>2025-04-03T22:36:10.0204745-04:00</Time>
<Tips>6</Tips>
</PulseDashboardSalesDetail>
</Details>
<LaborCost>12</LaborCost>
<ScheduledHours>11</ScheduledHours>
<TotalAppointments>14</TotalAppointments>
<TotalCommisions>8</TotalCommisions>
<TotalCost>6</TotalCost>
<TotalDiscounts>9</TotalDiscounts>
<TotalNewCustomers>10</TotalNewCustomers>
<TotalNumberOfTransactions>1</TotalNumberOfTransactions>
<TotalProductSales>4</TotalProductSales>
<TotalProductSalesGoal>16</TotalProductSalesGoal>
<TotalSales>3</TotalSales>
<TotalServiceSales>5</TotalServiceSales>
<TotalServiceSalesGoal>17</TotalServiceSalesGoal>
<TotalTips>7</TotalTips>
</PulseDashboard>